Thanks for downloading Advanced Fuel Mod, This mod is still very much a work in progress and will have bugs in it. I will be releasing updates as often as i can and i hope you continue to check back to get the latest version.

Contents
--------
1. How to install
2. Releases
3. Incompatibility
4. Errors and bug reports
5. Settings
6. Special Thanks


1. How To Install
-----------------
To install this mod, move the following files to you scripts folder:
	-Advanced_Fuel_Mod.dll
	-Advanced_Fuel_Mod_Settings.ini

Your Scripts folder should reside within your game folder. eg. D:\Program Files\GTAV\Scripts.

The other files in this archive are not necessary for the mod to run.


2. Releases
-----------
Releases will be published at https://www.gta5-mods.com/scripts/advanced-fuel-mod. I will try and have a link to a countdown timer on the sidebar so you can have an idea of when the next version will be out when i have some idea of the next release date, Although this is only a best guess.

I will also try to keep a link to a poll on the sidebar so you can vote for what features you want to see take priority.

I will also try and keep links to old versions in the sidebar. If an update breaks for whatever reason, you will be able to downgrade until i fix the issue.


3. Incompatibility
-------------------
This mod is currently incompatible with LSPD:FR, this is obviously a known issue, and fixing this is a priority.


4. Errors and Bug Reports
-------------------------
There will be bugs! but, i have made it as easy as possible to report them. Any errors reported from the program should be written to its own log file:
	-'AdvancedFuelMod_ErrorLog.txt'
If there are any issues with the mod or its not acting as it should, check if the above file has been created and leave its contents (or a link to the file) in the comments section of the mod page.

You can also check the following file in your game folder:
	-'ScriptHookVDotNet.log'

This file is an error log for all .NET mods and if this mod doesnt load (no icons on minimap, no fuel prices), this file is a good file to check and/or upload and place a link in the comments section of the mod page.

It would also help if you could leave in the same comment, a link to your .ini file (or just post the text from your ini file directly).

Some known issue resolvers:
	-ensure your decimals in your .ini file are converted to commas if your language uses that
	-ensure you have your keys values correct for keybindings

5. Settings
-----------
Advanced_Fuel_Mod_Settings.ini is where you will edit the mod settings. The sytax is very non-forgiving atm, so if the mod doesnt work as expected, this is the first place you should look. Values should contain no spaces.
	
5.1 Key Bindings
Keybindings have been updated to use Microsoft Keys Enumeration Member names which can be found here: 
	-https://msdn.microsoft.com/en-us/library/system.windows.forms.keys(v=vs.110).aspx
		-PLEASE NOTE: THS IS FOR ENGLISH USERS, NON-ENGLISH USERS WILL HAVE TO FIND THEIR KEYS ENUM VALUES FORT THEIR LANGUAGE. TRY GOOGLING 'MICROSOFT KEYS ENUM [YOUR LANGUAGE HERE]'

5.2 Settings
	VerticalFuelBar
		Values: TRUE, FALSE
		Description: Indicates weather your fuel bar will be horizontal or vertical.

	Units
		Values: M, I
		Description: M for metric, I for imperial.

5.3 Positions
	StatsX, StatsY, FuelGaugeX, FuelGaugeY, FuelGuageLength
		Values: Any number between 0 and 1
		Description: the X location of the vehicle statistics. The value represents a percentage of the screen where .5 is 50%

5.4 FuelBarColours
	All values under FuelBarColours
		Values: 0 to 255
		Description the Value of the Red, Green, Blue or Alpha portion of the colour.

5.5 BetaFeatures
	UseMoreFuelWhenPetrolTankLeaking
		Values: TRUE, FALSE
		Description: fuel consumption drastically increases when fuel tank is punctured and leaking.

6. Special Thanks
------------------
ShadowLocke for providing the code to read .ini files
	-http://bytes.com/topic/net/insights/797169-reading-parsing-ini-file-c

Sakis25 for the petrol station locations
	-https://www.gta5-mods.com/scripts/fuel-script-v-sakis25

Grrrooo for the 21:9 Screenshot
	-https://wit.wurfl.io/f_jpg/w_1600/http://files.gta5-mods.com/images/advanced-fuel-mod/9d51a6-nbqXvmV.jpg